/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.exception;

import bd.org.apache.commons.math.exception.util.Localizable;
import bd.org.apache.commons.math.exception.util.LocalizedFormats;

/**
 * Exception to be thrown when two dimensions differ.
 *
 * @version $Id$
 * @since 2.2
 */
public class DimensionMismatchException extends MathIllegalNumberException {

    /**
     * Serializable version Id.
     */
    private static final long serialVersionUID = -8415396756375798143L;

    /**
     * Correct dimension.
     */
    private final int dimension;

    /**
     * Construct an exception from the mismatched dimensions.
     *
     * @param wrong Wrong dimension.
     * @param expected Expected dimension.
     */
    public DimensionMismatchException(int wrong, int expected) {

        this(LocalizedFormats.DIMENSIONS_MISMATCH_SIMPLE, wrong, expected);
    }

    /**
     * Construct an exception from the mismatched dimensions.
     *
     * @param specific Specific context information pattern.
     * @param wrong Wrong dimension.
     * @param expected Expected dimension.
     */
    public DimensionMismatchException(Localizable specific, int wrong, int expected) {

        super(specific, wrong, expected);

        dimension = expected;
    }

    /**
     * @return the expected dimension.
     */
    public int getDimension() {

        return dimension;
    }
}
